Skip to content

chore: make some functions const#676

Merged
samueltardieu merged 1 commit intomainfrom
push-stksrmuyyrkr
Apr 13, 2025
Merged

chore: make some functions const#676
samueltardieu merged 1 commit intomainfrom
push-stksrmuyyrkr

Conversation

@samueltardieu
Copy link
Copy Markdown
Member

@samueltardieu samueltardieu commented Apr 13, 2025 •
edited by coderabbitai Bot
Loading

Also, enable the Clippy lint.

Summary by CodeRabbit

  • New Features

    • Introduced a new linting rule to enforce stricter checks on function definitions.

  • Refactor

    • Enhanced grid operations now support more flexible usage by allowing configuration toggling and inversion even in scenarios where modifications were previously restricted. This update improves performance and reliability while preserving core functionality.
    • Updated method signatures in the Grid implementation to allow invocation on immutable instances.

  • Chores

    • Strengthened internal quality controls with significantly updated guidelines to ensure a robust and maintainable codebase.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 13, 2025 •
edited
Loading

Walkthrough

The changes introduce a new linting rule in the Cargo.toml by adding missing_const_for_fn = "deny" to the Clippy configuration, enforcing stricter compile-time checks. Additionally, the signatures of three methods in src/grid.rs—enable_diagonal_mode, disable_diagonal_mode, and invert—have been updated from mutable functions to constant functions, allowing their invocation in constant contexts. The distance method in examples/sliding-puzzle.rs has also been modified to a constant method, enabling compile-time evaluation. The internal logic of these methods and other linting rules remain unchanged.

Changes

File(s) Change Summary
Cargo.toml Added a new linting rule: missing_const_for_fn = "deny" under [lints.clippy]
src/grid.rs Updated method signatures for enable_diagonal_mode, disable_diagonal_mode, and invert from pub fn to pub const fn to allow calls on immutable instances
examples/sliding-puzzle.rs Updated method signature for distance from fn distance(&self, idx: u8) -> u8 to const fn distance(&self, idx: u8) -> u8

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Cargo as Cargo
    participant Clippy as Clippy Linter

    Dev->>Cargo: Initiate build
    Cargo->>Clippy: Run lint checks (including missing_const_for_fn)
    Clippy-->>Cargo: Report lint errors if missing const is detected
    Cargo-->>Dev: Build fails if errors are present
Loading 
sequenceDiagram
    participant App as Application
    participant Grid as Grid Instance

    App->>Grid: Call enable_diagonal_mode() (const)
    Grid-->>App: Update diagonal_mode property to true
    App->>Grid: Call disable_diagonal_mode() (const)
    Grid-->>App: Update diagonal_mode property to false
    App->>Grid: Call invert() (const)
    Grid-->>App: Toggle dense property
Loading

Poem

In code meadows, I hop with glee,
New lint rules shine—a strict decree.
Grid methods now gleam as const and bright,
Guiding the code with a steadfast light.
I, the CodeRabbit, dance in delight!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b20542 and d367952.

📒 Files selected for processing (3)
  • Cargo.toml (1 hunks)
  • examples/sliding-puzzle.rs (1 hunks)
  • src/grid.rs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • Cargo.toml
  • src/grid.rs
🧰 Additional context used
🧬 Code Graph Analysis (1)
examples/sliding-puzzle.rs (4)
src/grid.rs (1)
  • distance (453-460)
tests/pathfinding.rs (1)
  • distance (183-185)
tests/r299.rs (1)
  • distance (55-57)
tests/grid.rs (1)
  • distance (514-525)
🔇 Additional comments (1)
examples/sliding-puzzle.rs (1)

78-78: Good optimization to make this function const!

Making the distance method a constant function is a good practice that allows for compile-time evaluation when used in const contexts. This change aligns well with the PR's objective of making suitable functions const and with the newly added Clippy lint rule missing_const_for_fn = "deny". Since this method only reads from the struct without modifying state and performs operations that are compatible with const contexts, it's an ideal candidate for this optimization.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@samueltardieu samueltardieu enabled auto-merge April 13, 2025 21:00
@samueltardieu samueltardieu added this pull request to the merge queue Apr 13, 2025
Merged via the queue into main with commit 649c1d9 Apr 13, 2025
14 checks passed
@samueltardieu samueltardieu deleted the push-stksrmuyyrkr branch April 13, 2025 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@samueltardieu